Skip to content

Fix all remaining spelling errors throughout the codebase #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

jakepetroules
Copy link
Collaborator

@jakepetroules jakepetroules commented Feb 23, 2025

...to the best of my knowledge.

I used cspell (brew install cspell) by running cspell lint -u --words-only --no-progress "**/*" | sort > words.txt, and then manually scanned through the list of around 2000 derived errors, skipping past technical terms or compound words that were valid but not in cspell's dictionaries.

This also standardized the spelling of a handful of words to US English, and tweaked the grammar of the surrounding sentence structure in a few cases where obscure constructed or slang words were used.

The majority of changes are in comments only, and most others in local variable names or test function names.

...to the best of my knowledge.

I used cspell (`brew install cspell`) by running `cspell lint -u --words-only --no-progress "**/*" | sort > words.txt`, and then manually scanned through the list of around 2000 derived errors, skipping past technical terms or compound words that were valid but not in cspell's dictionaries.

This also standardized the spelling of a handful of words to US English, and tweaked the grammar of the surrounding sentence structure in a few cases where obscure constructed or slang words were used.

The majority of changes are in comments only, and most others in local variable names or test function names.
@jakepetroules
Copy link
Collaborator Author

@swift-ci test

@jakepetroules jakepetroules enabled auto-merge (rebase) February 23, 2025 07:06
Copy link
Contributor

@MojtabaHs MojtabaHs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done! This tool seems excellent, and I believe we could make it mandatory for use on all PRs.

I’ve reviewed all the changes manually and found only one minor change that may need to be reconsidered, while the rest appear to be more suited for discussion.

Please let me know your thoughts on automating the use of this tool.

@jakepetroules jakepetroules merged commit 8420717 into main Feb 24, 2025
3 checks passed
@jakepetroules jakepetroules deleted the eng/PR-spelling branch February 24, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants